cs-selling-experience-api-services

(0 reviews)

lfs-2gq/📚 Data Dictionary - Experience Selling API

This section outlines the attributes and usage of the Experience Selling API.

💂 Base Information

API Title: Experience Selling API
Version: v1
Base URL:https://experience-selling-api-{env}.us-e1.cloudhub.io/api/Replace {env} with:
- dev (Development)
- qa (Quality Assurance)
- prod (Production)

🔑 Authentication

Required Headers

Header	Type	Description
Authorization	String	Bearer token in the format `Bearer {{API_KEY}}`
client_id	String	Unique identifier for API clients

📌 Both headers are required in all requests.

🛠️ Traits & Security

Traits

client-id-required: Ensures client_id is provided in the request header.

Security

Secured via OAuth 2.0 provided by lib-commons.oauth2.

📂 Services

📄 Policy Issuance

POST /PolicyIssuance/v1/generatePolicy

Description: Issues a new insurance policy.

Request Body Example

{
  "policyData": {
    "customerId": "123456",
    "plan": "Gold",
    "startDate": "2025-04-01"
  }
}

Response Example

{
  "policyId": "POL123456789",
  "status": "issued"
}

💳 Payments (PayU)

POST /Services/v1/Payu/paymentPayU

Description: Initiates a payment through PayU.

POST /Services/v1/Payu/paymentConfirmationPayU

Description: Confirms a PayU payment transaction.

📄 PDF Policy Service

POST /Services/v1/ServicePolicyPdf

Description: Generates a policy PDF.

🏦 Core Payment & Policy

POST /Services/v1/CorePayment

Description: Processes core system payments.

POST /Services/v1/CorePolicyIssuance

Description: Issues policies from the core system.
Doc: Refer to /documentation/post-core-policy-issuance.md

📦 Data Types & Examples

Defined types and examples are organized under:

types/types.raml
examples/request/*.json
examples/response/*.json

🔐 Security Schemes

Client ID Enforcement

Field	Type	Required	Length
client_id	String	Yes	32 - 36
client_secret	String	Yes	32 - 64

OAuth 2.0

Field	Type	Required	Format
Authorization	String	Yes	Bearer Token

⚠️ Error Handling

Code	Description	Resolution Suggestion
400	Bad Request	Check input format and parameters.
401	Unauthorized	Verify `client_id` and token.
404	Not Found	Ensure endpoint path is correct.
500	Internal Server Error	Retry or report to support.

📞 Support

For technical issues, contact:

Integration Services and Applications Coordination
📧 epalma@fgs.co

Last updated: April 2025